Summary
Inserts documents from a category, up to ten XML fields can be used for filtering.
Category | AS EPT |
Version | 2.0 |
Complies with Xhtml 1.0 / 1.1 rules | Yes |
Supported server programming languages | C# Visual Basic.NET |
Output content type | block |
When to use
This component is typically used for including one or more documents based on one ore more filter criterion.
Programming interface
Parameters
- Field parameter settings
- XMLField1
- The first field you want to use either in result criteria or sort.
- Data type 1
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField2
- The second field you want to use either in result criteria or sort.
- Data type 2
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField3
- The third field you want to use either in result criteria or sort.
- Data type 3
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField4
- The fourth field you want to use either in result criteria or sort.
- Data type 4
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField5
- The fifth field you want to use either in result criteria or sort.
- Data type 5
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField6
- The sixth field you want to use either in result criteria or sort.
- Data type 6
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField7
- The seventh field you want to use either in result criteria or sort.
- Data type 7
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField8
- The eighth field you want to use either in result criteria or sort.
- Data type 8
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField9
- The nineth field you want to use either in result criteria or sort.
- Data type 9
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- XMLField10
- The tenth field you want to use either in result criteria or sort.
- Data type 10
- The data type for this field. Must be specified for correct sorting or viewing. Warning: you must be sure that all values in this field corresponds to the chosen data type.
- FilterCriteria
- Optional filter criteria. Here you can type sql criterias using the fields you have choosen above. Ex: [Country] = 'Sweden'. You must enclose the fieldnames with [] and type them with correct casing.
- Sorting columns
- SortField1
- Optional the first field you want to sort on
- SortColumn1
- Optional sort column 1 text
- SortField2
- Optional the second field you want to sort on
- SortColumn2
- Optional sort column 2 text
- SortField3
- Optional the third field you want to sort on
- SortColumn3
- Optional sort column 3 text
- SortField4
- Optional the fourth field you want to sort on
- SortColumn4
- Optional sort column 4 text
- SortField5
- Optional the fifth field you want to sort on
- SortColumn5
- Optional sort column 5 text
- SortField6
- Optional the sixth field you want to sort on
- SortColumn6
- Optional sort column 6 text
- SortField7
- Optional the seventh field you want to sort on
- SortColumn7
- Optional sort column 7 text
- SortField8
- Optional the eight field you want to sort on
- SortColumn8
- Optional sort column 8 text
- SortField9
- Optional the ninth field you want to sort on
- SortColumn9
- Optional sort column 9 text
- SortField10
- Optional the tenth field you want to sort on
- SortColumn10
- Optional sort column 10 text
- Sorting settings
- DefaultSortField
- Default field you want to sort on
- SortCellAttributes
- Optional attributes for sort header cells
- SortTableAttributes
- Custum attributes in the table used for sorting. Ex: summary="Sorting table". Only used when UseTable is set to true.
- SortColProperties
- Custom elements in the table used for sorting. Ex: <caption>Sorting table</caption>. Only used when UseTable is set to true.
- SortDesc
- Sort descending
- Presentation template
- PTID
- Optional ptid
- Wordwrap
- Creates wordwrap between the listed documents
- Table settings
- UseTable
- Insert documents into table
- TableBorder
- Borderwidth
- TableCellPadding
- CellPadding
- TableCellSpacing
- CellSpacing
- TableWidth
- Width
- RowColor1
- Color of odd lines
- RowColor2
- Color of even lines
- TableAttributes
- Attributes in table.
- CodeBefore
- Code before page table
- CodeAfter
- Code after page table
- ColProperties
- Text labels and presentation>
- RecordTextTop
- Display this text on top only when records was returned, available constants is $RecordCount$ and $PageCount$.
- RecordTextBottom
- Display this text on bottom only when records was returned, available constants is $RecordCount$ and $PageCount$.
- NoRecordText
- Text displayed when no matching data could be found
- NoRecordDocId
- Document to be inserted when no matching data could be found
- NoRecordDocPTId
- Presentation template id for NoRecordDocId
- Paging settings
- UsePageing
-
Use paging. If not set the number of records shown will be limited by value of the
PageSize parameter. A PageSize of 0 will show all available records.
- Top
Use paging at the top. - Bottom
Use paging at the bottom. - Both
Use paging at both the bottom and the top.
- Top
- PageSize
- Max number of documents you want to list on each page.0 = All documents
- RangeSize
- Size of range
- UniqueID
- Change this parameter if you are using more than one component per page that utilize paging
- LinkAttributes
- Attributes in links.
- Handle posted pages
- Leading page range text
- Link separator text
- Separator between links
- Link prefix text
- Previous page range text
- Previous page text
- Next page text
- Next page range text
- Settings for alternative list in columns
- UseColumns
- Use this to insert documents in columns, UseTable must be checked!
- NumberOfColumns
- Specify number of columns to be inserted
- MLC settings
- IsMLCAware
- Check this to change category for filtering depending on current language. Without this option checked, "UseRoot", "AllowNonMLCParent" and "CheckLangCookie" will have no effect.
- CheckPTID
- Check this to make the presentation template MLC aware as well. Should be checked if using presentation template with MLC IsMLCAware checked.
- UseRoot
- Check this to fetch current language from root document (id in query string), rather than from the document in which the component is inserted. If no value can be retrieved from the query string, this option will be ignored.
- AllowNonMLCParent
- Unchecking this checkox will cause an error message to be displayed if the root document or inserted document, whichever you choose to check, is not a member of any MLC.
- CheckLangCookie
- Checks in cookie named "CS_Language" for language code to use as current language. Overrides UseRoot. If no value can be retrieved from the cookie, the component will try to get a valid language code from the document instead. Is overridden by value of "lang" in query string.
- Cache methods
-
- No cache
Do not cache the result from the xml query. - Use application cache
Cache the result from the xml query using application variables. This option should not be used at an intranet with security permissions set for the xml query items.
WARNING there are security problems with this parameter. See the Remarks section for more information.
- No cache
- Application cache timeout
- Timeout in minutes for the application cache, 0 = no timeout
- Check for read permission
- Specifies whether the component should check for read permission instead of browse or read.
Remarks
The documents inserted should not use a presentation template that contains metadata
Security Warning
If the component cache method is set to Use application cache, and the
xml query items contains security permissions which might differ among visitors,
a potential security problem exists. If a user that has high level access visits
the page where this component resides and the result is cached, a user with restricted
access that visits the page at a later time might be able to get hold of information
which should be inaccessible to him/her.